Version: Windows SDK 3.2.4

Objects

Transaction Result Object

TransactionResult Object

An object holding information about the result of a transaction.

tip

signatureUrl: In case the signature can not be updated to the Handpoint servers and an URL is not generated, the terminal will send back the image binary in base64 format to your software. It is important to be able to support both the URL and the image binary format.

customerReceipt and merchantReceipt: The receipts are usually received as URLs in the transaction result from the terminal. Please note that if the terminal is not able to upload the receipt to the Handpoint cloud servers and an URL is not generated then the HTML formatted receipt will be delivered to your software. It is important to be able to manage both formats.

Properties

Parameter	Notes
`aid` String	EMV Application Identifier of the card (EMV tag 9F06)
`arc` String	EMV Authorisation Response Code (EMV tag 8A)
`authorisationCode` String	Acquirer response code
`balance` BigInteger	Balance available on the card
`budgetNumber` String	Used to split payments over a period of months
`cardEntryType` CardEntryType	Method used by the terminal to read the card
`cardLanguagePreference` String	Preferred language of the card (EMV tag 5F2D)
`cardSchemeName` CardSchemeName	The brand of the card
`cardToken` String	Token representing the PAN of the card
`chipTransactionReport` String	Full report of the card EMV parameters
`currency` Currency	The currency used for the transaction
`customerReceipt` String	The receipts are usually received as URLs in the transaction result from the terminal but note that if the terminal is not able to upload the receipt to the Handpoint cloud servers and generate a URL then the HTML formatted receipt will be delivered to your software. It is important to be able to manage both formats
`customerReference` String	If a customerReference was provided as an optional parameter in the transaction request it is echoed unaltered in this field
`deviceStatus` DeviceStatus	Status of the payment terminal
`dueAmount` BigString	In case of a partial approval for the transaction, this field contains the amount which remains to be paid. Partial approval support is only required by the card brands in the United States
`efttimestamp` BigString	Time of the transaction (based on the date and time of the payment terminal)
`efttransactionID` String	Handpoint unique identifier for a transaction, this id is the one to be used for a transaction to be reversed.
`errorMessage` String	Detailed reason for the transaction error
`expiryDateMMYY` String	Expiry date of the card used for the operation
`finStatus` FinancialStatus	The financial status contains the outcome of the transaction. For example "AUTHORISED" or "DECLINED"
`iad` String	EMV Issuer Application Data (EMV tag 9F10)
`issuerResponseCode` String	Response code from the card issuer
`maskedCardNumber` String	Masked card number of the card used for the operation
`merchantAddress` String	Merchant Address
`merchantName` String	Merchant Name
`merchantReceipt` String	The receipts are usually received as URLs in the transaction result from the terminal but note that if the terminal is not able to upload the receipt to the Handpoint cloud servers and generate a URL then the HTML formatted receipt will be delivered to your software. It is important to be able to manage both formats
`mid` String	Merchant Identifier
`originalEFTTransactionID` String	In case the transaction type is a reversal, this field will contain the identifier of the original transaction being reversed
`paymentScenario` PaymentScenario	Indicates the card entry mode
`recoveredTransaction` boolean	This flag is set to true if the transaction result is sent through the transaction recovery logic explained in the Recovey Section, false otherwise
`requestedAmount` BigInteger	The requested amount is the transaction amount sent to the terminal
`rrn` String	Retrieval Reference Number, unique number assigned by the acquirer
`signatureUrl` String	If a digital signature is required, this is the URL containing the image of the captured signature. In case the signature can not be updated to the Handpoint servers and an URL is not generated, the terminal will send back the image binary in base64 format to your software. It is important to be able to support both the URL and the image binary format.
`statusMessage` String	The status of the transaction, for example "Waiting for pin"
`tenderType` TenderType	Transaction tender type (credit / debit)
`tid` String	Terminal Identifier
`tipAmount` BigInteger	Tip amount, if any, in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
`tipPercentage` double	If tipping is enabled, this field will return the tip percentage added on top of the base amount
`totalAmount` BigInteger	The total amount is the amount the card was charged for. It is possible that the total amount is not the same as the requested amount since an additional fee can be added, with the customer's approval, via the tipping functionality
`transactionID` String	The transaction id is a terminal internal counter incremented for each transaction
`tsi` String	EMV Transaction Status Information (EMV tag 9B)
`tvr` String	EMV Transaction Verification Results (EMV tag 95)
`type` TransactionType	The type of transaction initiated, for example "SALE"
`unMaskedPan` String	Unmasked PAN, only received if the card is a non-payment card (loyalty)
`verificationMethod` VerificationMethod	cardholder verification method, for example "PIN"

Code example

{
  "aid": "A0000000041010",
  "arc": "0000",
  "authorisationCode": "123456",
  "balance": null,
  "budgetNumber": "",
  "cardEntryType": "UNDEFINED",
  "cardLanguagePreference": "",
  "cardSchemeName": "MasterCard",
  "cardToken": "",
  "chipTransactionReport": "",
  "currency": "USD",
  "customerReceipt": "https://s3.[...]/customerReceipt.html",
  "customerReference": "",
  "deviceStatus": {
      "applicationName": "ClientApp",
      "applicationVersion": "20.1.0",
      "batteryCharging": "Not Charging",
      "batteryStatus": "100",
      "batterymV": "4126",
      "bluetoothName": "PAXA920",
      "externalPower": "USB",
      "serialNumber": "0821032398",
      "statusMessage": "Approved or completed successfully"
  },
  "dueAmount": 0,
  "errorMessage": "",
  "expiryDateMMYY": "0422",
  "finStatus": "AUTHORISED",
  "iad": "0210A000002A0000000000000000000000FF",
  "issuerResponseCode": "00",
  "maskedCardNumber": "************1456",
  "merchantAddress": "Plaza Soledad Torres Acosta 1 28013 Madrid",
  "merchantName": "Hago la cama",
  "merchantReceipt": "https://s3.[...]/merchantReceipt.html",
  "mid": "",
  "originalEFTTransactionID": "",
  "paymentScenario": "CHIPCONTACTLESS",
  "rrn": "",
  "signatureUrl": "",
  "statusMessage": "Approved or completed successfully",
  "tenderType": "CREDIT",
  "tid": "ACQUIRER_TID",
  "tipAmount": 0,
  "totalAmount": 100,
  "transactionID": "01236fc0-8192-11eb-9aca-ad4b0e95f241",
  "tsi": "0000",
  "tvr": "0400008001",
  "type": "SALE",
  "unMaskedPan": "",
  "verificationMethod": "UNDEFINED",
  "efttimestamp": 1615374961000,
  "efttransactionID": "01236fc0-8192-11eb-9aca-ad4b0e95f241",
  "requestedAmount": 100,
  "tipPercentage": 0,
  "recoveredTransaction": false
}

Handpoint Credentials

HandpointCredentials Object

A class containing information related to the user credentials.

Properties

Parameter	Notes
`SharedSecret` String	`String` the value of the shared secret (provided by Handpoint), only required when using BLUETOOTH as connection method. If using CLOUD this value can be any non-null string.
`CloudApiKey` String	`String` the value of the merchant Cloud Api Key (provided by Handpoint), only required when using CLOUD as connection method.

Code example

{
    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
    new HandpointCredentials(sharedSecret);
    //We've set a default shared secret!
}
    
{
    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
    string apikey = "This-Is-The-Merchant-Api-Key";
    new HandpointCredentials(sharedSecret, apikey);
    //We've set a default shared secret and the merchant Api Key!
}

Handpoint API (Hapi) factory

HapiFactory Object

A factory to provide a unified entrypoint and to simplify the way to instantiate the Hapi (SDK) object.

Methods

Static factory getAsyncInterface( Events.Required requiredListener , HandpointCredentials handpointCredentials );

Parameter	Notes
`requiredListener` Required Events.Required	A listener object to report the required events.
`handpointCredentials` Required HandpointCredentials	Object containing the user's shared secret and/or Cloud Api Key.

Code example

//InitApi for HiLite payment terminals
public void InitApi()
{
    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
    api = HapiFactory.GetAsyncInterface(this, new HandpointCredentials(sharedSecret));
    //The api is now initialized. Yay! we've even set a default shared secret
}

//InitApi for Cloud payment terminals (PAX/Telpo)
public void InitApi()
{
    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
    string apikey = "This-Is-The-Merchant-Api-Key";
    api = HapiFactory.GetAsyncInterface(this, new HandpointCredentials(sharedSecret, apikey));
    //The api is now initialized. Yay! we've even set a default shared secret and the merchant Api Key!
}

Transaction Type

TransactionType Enum

An enum representing different types of transactions.

Possible values

UNDEFINED SALE VOID_SALE REFUND VOID_REFUND CANCEL_SALE CANCEL_REFUND TOKENIZE_CARD SALE_AND_TOKENIZE_CARD REVERSAL UPDATE HOST_INIT PRINT_RECEIPT CARD_PAN CANCEL_TRX MOTO_SALE MOTO_REFUND MOTO_REVERSAL

Connection Method

ConnectionMethod Enum

An enum representing different types of connection methods.

BLUETOOTH, CLOUD and SIMULATOR are supported for Windows.

Possible values USB SERIAL BLUETOOTH CLOUD HTTPS WIFI ETHERNET SIMULATOR

Code example

//Currently CLOUD, BLUETOOTH, and SIMULATOR are the only ConnectionMethod available.
public enum ConnectionMethod 
{
    USB,
    SERIAL,
    HTTPS,
    WIFI,
    ETHERNET,
    BLUETOOTH,
    CLOUD,
    SIMULATOR
}

Device

Device Object

An object to store the information about the payment terminal in use.

Methods

Constructor

Device( String name , String address , String port , ConnectionMethod connectionMethod , String sharedSecret , int timeout );

Parameter	Notes
`name` Required String	A name to identify the payment terminal
`address` Required String	The address of the device you wish to connect to. E.g.: "08:00:69:02:01:FC" for bluetooth or "9822032398-PAXA920" for CLOUD (composition of serial number and model of the target device) .
`port` Required String	The port to connect to.
`connectionMethod` Required ConnectionMethod	The type of connection with the device. E.g: Bluetooth, Cloud, Serial, etc.
`sharedSecret` String	This parameter can be used to change the default shared secret for the payment terminal
`timeout` int	The number of miliseconds after which the connection is considered timed out

Code example

//Create and init a new HiLite payment terminal
Device dev = new Device("CardReader7", "08:00:69:02:01:FC", "1", ConnectionMethod.BLUETOOTH);

//Create and init a new PAX/Telpo payment terminal
Device dev = new Device("CloudDevice", "9822032398-PAXA920", "", ConnectionMethod.CLOUD);
// The address is the composition of the serial number and model ot the target device.
//Example for a PAX A920 device: serial_number - model  -> 9822032398-PAXA920

Properties

Property	Description
`Id` String	A unique identifier for the device.

Connection Status

ConnectionStatus Enum

A list of statuses given to a connection.

Possible values

Connected Connecting Disconnected Disconnecting Initializing NotConfigured

Currency

Currency Enum

An enum of currencies.

Possible values

AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYR BZD CAD CDF CHF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EEK EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MKD MMK MNT MOP MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UZS VEF VND VUV WST XAF XCD XOF XPF YER ZAR ZMK ZWL

Signature Request

SignatureRequest Object

A class containing information about a signature request or verification.

Properties

Property	Description
Timeout Int	The value of the timeout in seconds.
MerchantReceipt Html	The receipts are usually received as URLs in the transaction result from the terminal but note that if the terminal is not able to upload the receipt to the Handpoint cloud servers and generate a URL then the HTML formatted receipt will be delivered to your software. It is important to be able to manage both formats.

Card Scheme Name

CardSchemeName Enum

An enum representing different card brands.

Possible values

MasterCard Visa Maestro American Express Discover JCB Diners UnionPay Interac

Device Parameter

DeviceParameter Enum

An enum describing all the available commands to send to a device.

Possible values

BluetoothName BluetoothPass SystemTimeout ScreenTimeout SignatureTimeout Language

Device Status

DeviceStatus Enum

A class that holds the device status.

Properties

Property	Description
`SerialNumber` String	Gets the serial number of the device
`BatteryStatus` String	Gets the battery status in percentages of the device.
`BatterymV` String	Gets the battery milli volts of the device.
`BatteryChargingt` String	Gets the battery charging status of the device.
`ExternalPower` String	Gets the status of an external power source for the device.
`ApplicationName` String	Gets the application name used by the device.
`ApplicationVersion` String	Gets the application version number used by the device.

Terminal Parameters

TerminalType Enum

An enum describing parameters supported by the payment terminal.

Possible values

BluetoothName BluetoothPass SystemTimeout ScreenTimeout SignatureTimeout Language

Financial Status

FinancialStatus Enum

An enum representing different final statuses of a transaction.

Possible values

UNDEFINED AUTHORISED DECLINED PROCESSED FAILED CANCELLED

Description of the different financial statuses:

Parameter	Notes
`UNDEFINED`	Any Financial Status other than the below mentioned financial statuses will be `UNDEFINED`. UNDEFINED means that the SDK couldn't get a response from the Gateway. An automatic cancellation service will try to cancel the transaction in case it was approved.
`AUTHORISED`	The transaction (Sale, Refund,...) has been authorised. Consider this value as "successful".
`DECLINED`	The transaction has been declined by the acquirer or issuer.
`PROCESSED`	The `printReceipt` operation was successful.
`FAILED`	Status generated due to a network error, a card which can not be read etc. As a general rule, errors are mapped to `FAILED`.
`CANCELLED`	The transaction has been cancelled. For example if the `stopCurrentTransaction` operation has been used or the cancel button on the terminal has been pressed.
`PARTIAL_APPROVAL`	A partial approval is the ability to partially authorize a transaction if the cardholder does not have the funds to cover the entire cost on their card. The merchant can obtain the remainder of the purchase amount in another form of payment. `PARTIAL_APPROVAL` is only applicable to the United States market.

Optional Transaction Parameters

OptionalParameters Object

A class containing optional transaction parameters now supported by the device.

Properties

Property	Description
`Budget` String	Budget is only available for sale transactions. A `String` representing the key for a budget number.A budget number can be used to split up an amout over a period of months. The value has to be a `String` of 2 digits representing the number of months to split the transaction to. Example: "03" or "24".
`CustomerReference` String	String CustomerReference is available for all transactions. A `String` representing the key for a customer reference.A customer reference can be used for an internal marking system. The value is sent as a `String` of a maximum 36 characters and received back when the transaction has been processed. Example: "C.nr. 212311".

Log Level

LogLevel Enum

An enum describing the different levels of logging used in the SDK and the payment terminal.

Possible values

None Info Full Debug

Status Info

statusInfo Object

A class containing information about the status of the transaction.

Properties

Property	Description
`CancelAllowed` bool	A `bool` allowing the user to know if the payment terminal will accept a cancel request.
`status` Status	A `Status` enum representing the status of the transaction.
`message` String	A `String` containing the status message of the transaction.
`DeviceStatus` DeviceStatus	A `DeviceStatus` object containing information about the payment terminal.

Verification Method

VerificationMethod Enum

An enum representing different cardholder verification methods.

Possible values

UNDEFINED SIGNATURE PIN PIN_SIGNATURE FAILED NOT_REQUIRED MOBILE_PASS_CODE

Payment Scenario

PaymentScenario Enum

An enum representing different types of payment scenarios.

Possible values

UNKNOWN MAGSTRIPE MAGSTRIPECONTACTLESS CHIP CHIPCONTACTLESS CHIPFAILMAGSTRIPE

Status

status Enum

An enum containing information about the status of the transaction.

Possible values

Undefined Success InvalidData ProcessingError CommandNotAllowed NotInitialised ConnectTimeout ConnectError SendingError ReceivingError NoDataAvailable TransactionNotAllowed UnsupportedCurrency NoHostAvailable CardReaderError CardReadingFailed InvalidCard InputTimeout UserCancelled InvalidSignature WaitingForCard CardInserted ApplicationSelection ApplicationConfirmation AmountValidation PinInput ManualCardInput WaitingForCardRemoval TipInput SharedSecretInvalid SharedSecretAuth WaitingSignature WaitingHostConnect WaitingHostSend WaitingHostReceive WaitingHostDisconnect PinInputCompleted PosCancelled RequestInvalid CardCancelled CardBlocked RequestAuthTimeout RequestPaymentTimeout ResponseAuthTimeout ResponsePaymentTimeout IccCardSwiped RemoveCard ScannerIsNotSupported ScannerEvent BatteryTooLow AccountTypeSelection BtIsNotSupported PaymentCodeSelection PartialApproval AmountDueValidation InvalidUrl WaitingCustomerReceipt PrintingMerchantReceipt PrintingCustomerReceipt UpdateStarted UpdateFinished UpdateFailed UpdateProgress WaitingHostPostSend WaitingHostPostReceive Rebooting PrinterOutOfPaper ErrorConnectingToPrinter CardTapped ReceiptPrintSuccess InvalidPinLength OfflinePinAttempt OfflinePinLastAttempt ProcessingSignature CardRemoved TipEntered CardLanguagePreference AutomaticPrintingStarted CancelOperationNotAllowed UpdateSoftwareStarted UpdateSoftwareFinished UpdateSoftwareFailed UpdateSoftwareProgress InstallSoftwareStarted InstallSoftwareFinished InstallSoftwareFailed InstallSoftwareProgress UpdateConfigStarted UpdateConfigFinished UpdateConfigFailed UpdateConfigProgress InitialisationComplete

Tender Type

TenderType Enum

An enum representing different tender types.

Possible values

NOT_SET CREDIT DEBIT

Card Entry Type

CardEntryType Enum

An enum representing different card entry types.

Possible values

UNDEFINED MSR ICC CNP

Hapi Manager

HapiManager Object

A static class containing information about the current status of the SDK

Properties

Property	Description
`DefaultSharedSecret` String	Gets the default shared secret used in the SDK.
`LogLevel` LogLevel	Gets the current log level of the SDK and payment terminal.
`inTransaction` bool	Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.
`SdkVersion` String	Gets the current Sdk version.
`IsTransactionResultPending` boolean	In case of a communication failure between the device and the API a Transaction Result might not be delivered to the API. This function checks if there is a pending Transaction Result. This field is only updated when connecting to a device. If this function returns true the Transaction Result (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.
`Settings.AutoRecoverTransactionResult` boolean	In case of a communication failure between the device and the API a Transaction Result might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending Transaction Result when detected and return it via TransactionResultReady. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.

Code example

//Check if the SDK is in transaction
bool inTransaction = HapiManager.InTransaction(SomeConnectedDevice);
//Check the current logLevel
LogLevel level = HapiManager.GetLogLevel();

Objects

Transaction Result Object​

Handpoint Credentials​

Handpoint API (Hapi) factory​

Transaction Type​

Connection Method​

Device​

Connection Status​

Currency​

Signature Request​

Card Scheme Name​

Device Parameter​

Device Status​

Terminal Parameters​

Financial Status​

Optional Transaction Parameters​

Log Level​

Status Info​

Verification Method​

Payment Scenario​

Status​

Tender Type​

Card Entry Type​

Hapi Manager​

Transaction Result Object

Handpoint Credentials

Handpoint API (Hapi) factory

Transaction Type

Connection Method

Device

Connection Status

Currency

Signature Request

Card Scheme Name

Device Parameter

Device Status

Terminal Parameters

Financial Status

Optional Transaction Parameters

Log Level

Status Info

Verification Method

Payment Scenario

Status

Tender Type

Card Entry Type

Hapi Manager